Linux Cubed Series 2: Applications

home *** CD-ROM | disk | FTP | other *** search

/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.006 / xemacs-1 / lib / xemacs-19.13 / info / lispref.info-37 < prev next >

Wrap

GNU Info File | 1995-09-01 | 36.3 KB | 1,198 lines

This is Info file ../../info/lispref.info, produced by Makeinfo-1.63 from the input file lispref.texi. Edition History: GNU Emacs Lisp Reference Manual Second Edition (v2.01), May 1993 GNU Emacs Lisp Reference Manual Further Revised (v2.02), August 1993 Lucid Emacs Lisp Reference Manual (for 19.10) First Edition, March 1994 XEmacs Lisp Programmer's Manual (for 19.12) Second Edition, April 1995 GNU Emacs Lisp Reference Manual v2.4, June 1995 XEmacs Lisp Programmer's Manual (for 19.13) Third Edition, July 1995 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. Copyright (C) 1994, 1995 Sun Microsystems, Inc. Copyright (C) 1995 Amdahl Corporation. Copyright (C) 1995 Ben Wing. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Foundation. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the section entitled "GNU General Public License" is included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that the section entitled "GNU General Public License" may be included in a translation approved by the Free Software Foundation instead of in the original English. File: lispref.info, Node: Writing XEmacs Primitives, Next: Object Internals, Prev: Garbage Collection, Up: XEmacs Internals Writing XEmacs Primitives ========================= Lisp primitives are Lisp functions implemented in C. The details of interfacing the C function so that Lisp can call it are handled by a few C macros. The only way to really understand how to write new C code is to read the source, but we can explain some things here. An example of a special form is the definition of `or', from `eval.c'. (An ordinary function would have the same general appearance.) DEFUN ("or", For, Sor, 0, UNEVALLED, 0, "Eval args until one of them yields non-nil, then return that value.\n\ The remaining args are not evalled at all.\n\ If all args return nil, return nil.") (args) Lisp_Object args; { register Lisp_Object val; Lisp_Object args_left; struct gcpro gcpro1; if (NULL (args)) return Qnil; args_left = args; GCPRO1 (args_left); do { val = Feval (Fcar (args_left)); if (!NULL (val)) break; args_left = Fcdr (args_left); } while (!NULL (args_left)); UNGCPRO; return val; } Let's start with a precise explanation of the arguments to the `DEFUN' macro. Here is a template for them: DEFUN (LNAME, FNAME, SNAME, MIN, MAX, INTERACTIVE, DOC) LNAME This is the name of the Lisp symbol to define as the function name; in the example above, it is `or'. FNAME This is the C function name for this function. This is the name that is used in C code for calling the function. The name is, by convention, `F' prepended to the Lisp name, with all dashes (`-') in the Lisp name changed to underscores. Thus, to call this function from C code, call `For'. Remember that the arguments must be of type `Lisp_Object'; various macros and functions for creating values of type `Lisp_Object' are declared in the file `lisp.h'. SNAME This is a C variable name to use for a structure that holds the data for the subr object that represents the function in Lisp. This structure conveys the Lisp symbol name to the initialization routine that will create the symbol and store the subr object as its definition. By convention, this name is always FNAME with `F' replaced with `S'. MIN This is the minimum number of arguments that the function requires. The function `or' allows a minimum of zero arguments. MAX This is the maximum number of arguments that the function accepts, if there is a fixed maximum. Alternatively, it can be `UNEVALLED', indicating a special form that receives unevaluated arguments, or `MANY', indicating an unlimited number of evaluated arguments (the equivalent of `&rest'). Both `UNEVALLED' and `MANY' are macros. If MAX is a number, it may not be less than MIN and it may not be greater than seven. INTERACTIVE This is an interactive specification, a string such as might be used as the argument of `interactive' in a Lisp function. In the case of `or', it is 0 (a null pointer), indicating that `or' cannot be called interactively. A value of `""' indicates a function that should receive no arguments when called interactively. DOC This is the documentation string. It is written just like a documentation string for a function defined in Lisp, except you must write `\n\' at the end of each line. In particular, the first line should be a single sentence. After the call to the `DEFUN' macro, you must write the argument name list that every C function must have, followed by ordinary C declarations for the arguments. For a function with a fixed maximum number of arguments, declare a C argument for each Lisp argument, and give them all type `Lisp_Object'. When a Lisp function has no upper limit on the number of arguments, its implementation in C actually receives exactly two arguments: the first is the number of Lisp arguments, and the second is the address of a block containing their values. They have types `int' and `Lisp_Object *'. Within the function `For' itself, note the use of the macros `GCPRO1' and `UNGCPRO'. `GCPRO1' is used to "protect" a variable from garbage collection--to inform the garbage collector that it must look in that variable and regard its contents as an accessible object. This is necessary whenever you call `Feval' or anything that can directly or indirectly call `Feval'. At such a time, any Lisp object that you intend to refer to again must be protected somehow. `UNGCPRO' cancels the protection of the variables that are protected in the current function. It is necessary to do this explicitly. For most data types, it suffices to protect at least one pointer to the object; as long as the object is not recycled, all pointers to it remain valid. This is not so for strings, because the garbage collector can move them. When the garbage collector moves a string, it relocates all the pointers it knows about; any other pointers become invalid. Therefore, you must protect all pointers to strings across any point where garbage collection may be possible. The macro `GCPRO1' protects just one local variable. If you want to protect two, use `GCPRO2' instead; repeating `GCPRO1' will not work. Macros `GCPRO3' and `GCPRO4' also exist. These macros implicitly use local variables such as `gcpro1'; you must declare these explicitly, with type `struct gcpro'. Thus, if you use `GCPRO2', you must declare `gcpro1' and `gcpro2'. Alas, we can't explain all the tricky details here. You must not use C initializers for static or global variables unless they are never written once XEmacs is dumped. These variables with initializers are allocated in an area of memory that becomes read-only (on certain operating systems) as a result of dumping XEmacs. *Note Pure Storage::. Do not use static variables within functions--place all static variables at top level in the file. This is necessary because XEmacs on some operating systems defines the keyword `static' as a null macro. (This definition is used because those systems put all variables declared static in a place that becomes read-only after dumping, whether they have initializers or not.) Defining the C function is not enough to make a Lisp primitive available; you must also create the Lisp symbol for the primitive and store a suitable subr object in its function cell. The code looks like this: defsubr (&SUBR-STRUCTURE-NAME); Here SUBR-STRUCTURE-NAME is the name you used as the third argument to `DEFUN'. If you add a new primitive to a file that already has Lisp primitives defined in it, find the function (near the end of the file) named `syms_of_SOMETHING', and add the call to `defsubr' there. If the file doesn't have this function, or if you create a new file, add to it a `syms_of_FILENAME' (e.g., `syms_of_myfile'). Then find the spot in `emacs.c' where all of these functions are called, and add a call to `syms_of_FILENAME' there. The function `syms_of_FILENAME' is also the place to define any C variables that are to be visible as Lisp variables. `DEFVAR_LISP' makes a C variable of type `Lisp_Object' visible in Lisp. `DEFVAR_INT' makes a C variable of type `int' visible in Lisp with a value that is always an integer. `DEFVAR_BOOL' makes a C variable of type `int' visible in Lisp with a value that is either `t' or `nil'. Here is another example function, with more complicated arguments. This comes from the code for the X Window System, and it demonstrates the use of macros and functions to manipulate Lisp objects. DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p, Scoordinates_in_window_p, 2, 2, "xSpecify coordinate pair: \nXExpression which evals to window: ", "Return non-nil if POSITIONS is in WINDOW.\n\ \(POSITIONS is a list, (SCREEN-X SCREEN-Y)\)\n\ Returned value is list of positions expressed\n\ relative to window upper left corner.") (coordinate, window) register Lisp_Object coordinate, window; { register Lisp_Object xcoord, ycoord; if (!CONSP (coordinate)) wrong_type_argument (Qlistp, coordinate); CHECK_WINDOW (window, 2); xcoord = Fcar (coordinate); ycoord = Fcar (Fcdr (coordinate)); CHECK_NUMBER (xcoord, 0); CHECK_NUMBER (ycoord, 1); if ((XINT (xcoord) < XINT (XWINDOW (window)->left)) || (XINT (xcoord) >= (XINT (XWINDOW (window)->left) + XINT (XWINDOW (window)->width)))) return Qnil; XFASTINT (xcoord) -= XFASTINT (XWINDOW (window)->left); if (XINT (ycoord) == (frame_height - 1)) return Qnil; if ((XINT (ycoord) < XINT (XWINDOW (window)->top)) || (XINT (ycoord) >= (XINT (XWINDOW (window)->top) + XINT (XWINDOW (window)->height)) - 1)) return Qnil; XFASTINT (ycoord) -= XFASTINT (XWINDOW (window)->top); return (Fcons (xcoord, Fcons (ycoord, Qnil))); } Note that C code cannot call functions by name unless they are defined in C. The way to call a function written in Lisp is to use `Ffuncall', which embodies the Lisp function `funcall'. Since the Lisp function `funcall' accepts an unlimited number of arguments, in C it takes two: the number of Lisp-level arguments, and a one-dimensional array containing their values. The first Lisp-level argument is the Lisp function to call, and the rest are the arguments to pass to it. Since `Ffuncall' can call the evaluator, you must protect pointers from garbage collection around the call to `Ffuncall'. The C functions `call0', `call1', `call2', and so on, provide handy ways to call a Lisp function conveniently with a fixed number of arguments. They work by calling `Ffuncall'. `eval.c' is a very good file to look through for examples; `lisp.h' contains the definitions for some important macros and functions. File: lispref.info, Node: Object Internals, Prev: Writing XEmacs Primitives, Up: XEmacs Internals Object Internals ================ Emacs Lisp manipulates many different types of data. The actual data are stored in a heap and the only access that programs have to it is through pointers. Pointers are thirty-two bits wide in most implementations. Depending on the operating system and type of machine for which you compile XEmacs, twenty-four to twenty-six bits are used to address the object, and the remaining six to eight bits are used for a tag that identifies the object's type. Because Lisp objects are represented as tagged pointers, it is always possible to determine the Lisp data type of any object. The C data type `Lisp_Object' can hold any Lisp object of any data type. Ordinary variables have type `Lisp_Object', which means they can hold any type of Lisp value; you can determine the actual data type only at run time. The same is true for function arguments; if you want a function to accept only a certain type of argument, you must check the type explicitly using a suitable predicate (*note Type Predicates::.). * Menu: * Buffer Internals:: Components of a buffer structure. * Window Internals:: Components of a window structure. * Process Internals:: Components of a process structure. File: lispref.info, Node: Buffer Internals, Next: Window Internals, Prev: Object Internals, Up: Object Internals Buffer Internals ---------------- Buffers contain fields not directly accessible by the Lisp programmer. We describe them here, naming them by the names used in the C code. Many are accessible indirectly in Lisp programs via Lisp primitives. `name' The buffer name is a string that names the buffer. It is guaranteed to be unique. *Note Buffer Names::. `save_modified' This field contains the time when the buffer was last saved, as an integer. *Note Buffer Modification::. `modtime' This field contains the modification time of the visited file. It is set when the file is written or read. Every time the buffer is written to the file, this field is compared to the modification time of the file. *Note Buffer Modification::. `auto_save_modified' This field contains the time when the buffer was last auto-saved. `last_window_start' This field contains the `window-start' position in the buffer as of the last time the buffer was displayed in a window. `undo_list' This field points to the buffer's undo list. *Note Undo::. `syntax_table_v' This field contains the syntax table for the buffer. *Note Syntax Tables::. `downcase_table' This field contains the conversion table for converting text to lower case. *Note Case Table::. `upcase_table' This field contains the conversion table for converting text to upper case. *Note Case Table::. `case_canon_table' This field contains the conversion table for canonicalizing text for case-folding search. *Note Case Table::. `case_eqv_table' This field contains the equivalence table for case-folding search. *Note Case Table::. `display_table' This field contains the buffer's display table, or `nil' if it doesn't have one. *Note Display Tables::. `markers' This field contains the chain of all markers that currently point into the buffer. Deletion of text in the buffer, and motion of the buffer's gap, must check each of these markers and perhaps update it. *Note Markers::. `backed_up' This field is a flag that tells whether a backup file has been made for the visited file of this buffer. `mark' This field contains the mark for the buffer. The mark is a marker, hence it is also included on the list `markers'. *Note The Mark::. `mark_active' This field is non-`nil' if the buffer's mark is active. `local_var_alist' This field contains the association list describing the variables local in this buffer, and their values, with the exception of local variables that have special slots in the buffer object. (Those slots are omitted from this table.) *Note Buffer-Local Variables::. `modeline_format' This field contains a Lisp object which controls how to display the mode line for this buffer. *Note Modeline Format::. `base_buffer' This field holds the buffer's base buffer (if it is an indirect buffer), or `nil'. File: lispref.info, Node: Window Internals, Next: Process Internals, Prev: Buffer Internals, Up: Object Internals Window Internals ---------------- Windows have the following accessible fields: `frame' The frame that this window is on. `mini_p' Non-`nil' if this window is a minibuffer window. `buffer' The buffer that the window is displaying. This may change often during the life of the window. `dedicated' Non-`nil' if this window is dedicated to its buffer. `pointm' This is the value of point in the current buffer when this window is selected; when it is not selected, it retains its previous value. `start' The position in the buffer that is the first character to be displayed in the window. `force_start' If this flag is non-`nil', it says that the window has been scrolled explicitly by the Lisp program. This affects what the next redisplay does if point is off the screen: instead of scrolling the window to show the text around point, it moves point to a location that is on the screen. `last_modified' The `modified' field of the window's buffer, as of the last time a redisplay completed in this window. `last_point' The buffer's value of point, as of the last time a redisplay completed in this window. `left' This is the left-hand edge of the window, measured in columns. (The leftmost column on the screen is column 0.) `top' This is the top edge of the window, measured in lines. (The top line on the screen is line 0.) `height' The height of the window, measured in lines. `width' The width of the window, measured in columns. `next' This is the window that is the next in the chain of siblings. It is `nil' in a window that is the rightmost or bottommost of a group of siblings. `prev' This is the window that is the previous in the chain of siblings. It is `nil' in a window that is the leftmost or topmost of a group of siblings. `parent' Internally, XEmacs arranges windows in a tree; each group of siblings has a parent window whose area includes all the siblings. This field points to a window's parent. Parent windows do not display buffers, and play little role in display except to shape their child windows. Emacs Lisp programs usually have no access to the parent windows; they operate on the windows at the leaves of the tree, which actually display buffers. `hscroll' This is the number of columns that the display in the window is scrolled horizontally to the left. Normally, this is 0. `use_time' This is the last time that the window was selected. The function `get-lru-window' uses this field. `display_table' The window's display table, or `nil' if none is specified for it. `update_mode_line' Non-`nil' means this window's mode line needs to be updated. `base_line_number' The line number of a certain position in the buffer, or `nil'. This is used for displaying the line number of point in the mode line. `base_line_pos' The position in the buffer for which the line number is known, or `nil' meaning none is known. `region_showing' If the region (or part of it) is highlighted in this window, this field holds the mark position that made one end of that region. Otherwise, this field is `nil'. File: lispref.info, Node: Process Internals, Prev: Window Internals, Up: Object Internals Process Internals ----------------- The fields of a process are: `name' A string, the name of the process. `command' A list containing the command arguments that were used to start this process. `filter' A function used to accept output from the process instead of a buffer, or `nil'. `sentinel' A function called whenever the process receives a signal, or `nil'. `buffer' The associated buffer of the process. `pid' An integer, the Unix process ID. `childp' A flag, non-`nil' if this is really a child process. It is `nil' for a network connection. `mark' A marker indicating the position of the end of the last output from this process inserted into the buffer. This is often but not always the end of the buffer. `kill_without_query' If this is non-`nil', killing XEmacs while this process is still running does not ask for confirmation about killing the process. `raw_status_low' `raw_status_high' These two fields record 16 bits each of the process status returned by the `wait' system call. `status' The process status, as `process-status' should return it. `tick' `update_tick' If these two fields are not equal, a change in the status of the process needs to be reported, either by running the sentinel or by inserting a message in the process buffer. `pty_flag' Non-`nil' if communication with the subprocess uses a PTY; `nil' if it uses a pipe. `infd' The file descriptor for input from the process. `outfd' The file descriptor for output to the process. `subtty' The file descriptor for the terminal that the subprocess is using. (On some systems, there is no need to record this, so the value is `nil'.) `tty_name' The name of the terminal that the subprocess is using, or `nil' if it is using pipes. File: lispref.info, Node: Standard Errors, Next: Standard Buffer-Local Variables, Prev: XEmacs Internals, Up: Top Standard Errors *************** Here is the complete list of the error symbols in standard Emacs, grouped by concept. The list includes each symbol's message (on the `error-message' property of the symbol) and a cross reference to a description of how the error can occur. Each error symbol has an `error-conditions' property that is a list of symbols. Normally this list includes the error symbol itself and the symbol `error'. Occasionally it includes additional symbols, which are intermediate classifications, narrower than `error' but broader than a single error symbol. For example, all the errors in accessing files have the condition `file-error'. As a special exception, the error symbol `quit' does not have the condition `error', because quitting is not considered an error. *Note Errors::, for an explanation of how errors are generated and handled. `SYMBOL' STRING; REFERENCE. `error' `"error"' *Note Errors::. `quit' `"Quit"' *Note Quitting::. `args-out-of-range' `"Args out of range"' *Note Sequences Arrays Vectors::. `arith-error' `"Arithmetic error"' See `/' and `%' in *Note Numbers::. `beginning-of-buffer' `"Beginning of buffer"' *Note Motion::. `buffer-read-only' `"Buffer is read-only"' *Note Read Only Buffers::. `cyclic-function-indirection' `"Symbol's chain of function indirections contains a loop"' *Note Function Indirection::. `domain-error' `"Arithmetic domain error"' `end-of-buffer' `"End of buffer"' *Note Motion::. `end-of-file' `"End of file during parsing"' This is not a `file-error'. *Note Input Functions::. `file-error' This error and its subcategories do not have error-strings, because the error message is constructed from the data items alone when the error condition `file-error' is present. *Note Files::. `file-locked' This is a `file-error'. *Note File Locks::. `file-already-exists' This is a `file-error'. *Note Writing to Files::. `file-supersession' This is a `file-error'. *Note Modification Time::. `invalid-function' `"Invalid function"' *Note Classifying Lists::. `invalid-read-syntax' `"Invalid read syntax"' *Note Input Functions::. `invalid-regexp' `"Invalid regexp"' *Note Regular Expressions::. `mark-inactive' `"The mark is not active now"' `no-catch' `"No catch for tag"' *Note Catch and Throw::. `overflow-error' `"Arithmetic overflow error"' `protected-field' `"Attempt to modify a protected field"' `range-error' `"Arithmetic range error"' `search-failed' `"Search failed"' *Note Searching and Matching::. `setting-constant' `"Attempt to set a constant symbol"' The values of the symbols `nil' and `t' may not be changed. *Note Variables that Never Change: Constant Variables. `singularity-error' `"Arithmetic singularity error"' `tooltalk-error' `"ToolTalk error"' *Note ToolTalk Support::. `undefined-keystroke-sequence' `"Undefined keystroke sequence"' `underflow-error' `"Arithmetic underflow error"' `void-function' `"Symbol's function definition is void"' *Note Function Cells::. `void-variable' `"Symbol's value as variable is void"' *Note Accessing Variables::. `wrong-number-of-arguments' `"Wrong number of arguments"' *Note Classifying Lists::. `wrong-type-argument' `"Wrong type argument"' *Note Type Predicates::. These error types, which are all classified as special cases of `arith-error', can occur on certain systems for invalid use of mathematical functions. `domain-error' `"Arithmetic domain error"' *Note Math Functions::. `overflow-error' `"Arithmetic overflow error"' *Note Math Functions::. `range-error' `"Arithmetic range error"' *Note Math Functions::. `singularity-error' `"Arithmetic singularity error"' *Note Math Functions::. `underflow-error' `"Arithmetic underflow error"' *Note Math Functions::. File: lispref.info, Node: Standard Buffer-Local Variables, Next: Standard Keymaps, Prev: Standard Errors, Up: Top Buffer-Local Variables ********************** The table below lists the general-purpose Emacs variables that are automatically local (when set) in each buffer. Many Lisp packages define such variables for their internal use; we don't list them here. `abbrev-mode' *note Abbrevs::. `auto-fill-function' *note Auto Filling::. `buffer-auto-save-file-name' *note Auto-Saving::. `buffer-backed-up' *note Backup Files::. `buffer-display-table' *note Display Tables::. `buffer-file-format' *note Format Conversion::. `buffer-file-name' *note Buffer File Name::. `buffer-file-number' *note Buffer File Name::. `buffer-file-truename' *note Buffer File Name::. `buffer-file-type' *note Files and MS-DOS::. `buffer-invisibility-spec' *note Invisible Text::. `buffer-offer-save' *note Saving Buffers::. `buffer-read-only' *note Read Only Buffers::. `buffer-saved-size' *note Point::. `buffer-undo-list' *note Undo::. `cache-long-line-scans' *note Text Lines::. `case-fold-search' *note Searching and Case::. `ctl-arrow' *note Usual Display::. `comment-column' *note Comments: (emacs)Comments. `default-directory' *note System Environment::. `defun-prompt-regexp' *note List Motion::. `fill-column' *note Auto Filling::. `goal-column' *note Moving Point: (emacs)Moving Point. `left-margin' *note Indentation::. `local-abbrev-table' *note Abbrevs::. `local-write-file-hooks' *note Saving Buffers::. `major-mode' *note Mode Help::. `mark-active' *note The Mark::. `mark-ring' *note The Mark::. `minor-modes' *note Minor Modes::. `modeline-format' *note Modeline Data::. `modeline-buffer-identification' *note Modeline Variables::. `modeline-format' *note Modeline Data::. `modeline-modified' *note Modeline Variables::. `modeline-process' *note Modeline Variables::. `mode-name' *note Modeline Variables::. `overwrite-mode' *note Insertion::. `paragraph-separate' *note Standard Regexps::. `paragraph-start' *note Standard Regexps::. `point-before-scroll' Used for communication between mouse commands and scroll-bar commands. `require-final-newline' *note Insertion::. `selective-display' *note Selective Display::. `selective-display-ellipses' *note Selective Display::. `tab-width' *note Usual Display::. `truncate-lines' *note Truncation::. `vc-mode' *note Modeline Variables::. File: lispref.info, Node: Standard Keymaps, Next: Standard Hooks, Prev: Standard Buffer-Local Variables, Up: Top Standard Keymaps **************** The following symbols are used as the names for various keymaps. Some of these exist when XEmacs is first started, others are loaded only when their respective mode is used. This is not an exhaustive list. Almost all of these maps are used as local maps. Indeed, of the modes that presently exist, only Vip mode and Terminal mode ever change the global keymap. `bookmark-map' A keymap containing bindings to bookmark functions. `Buffer-menu-mode-map' A keymap used by Buffer Menu mode. `c++-mode-map' A keymap used by C++ mode. `c-mode-map' A keymap used by C mode. A sparse keymap used by C mode. `command-history-map' A keymap used by Command History mode. `ctl-x-4-map' A keymap for subcommands of the prefix `C-x 4'. `ctl-x-5-map' A keymap for subcommands of the prefix `C-x 5'. `ctl-x-map' A keymap for `C-x' commands. `debugger-mode-map' A keymap used by Debugger mode. `dired-mode-map' A keymap for `dired-mode' buffers. `edit-abbrevs-map' A keymap used in `edit-abbrevs'. `edit-tab-stops-map' A keymap used in `edit-tab-stops'. `electric-buffer-menu-mode-map' A keymap used by Electric Buffer Menu mode. `electric-history-map' A keymap used by Electric Command History mode. `emacs-lisp-mode-map' A keymap used by Emacs Lisp mode. `help-map' A keymap for characters following the Help key. `Helper-help-map' A keymap used by the help utility package. It has the same keymap in its value cell and in its function cell. `Info-edit-map' A keymap used by the `e' command of Info. `Info-mode-map' A keymap containing Info commands. `isearch-mode-map' A keymap that defines the characters you can type within incremental search. `itimer-edit-map' A keymap used when in Itimer Edit mode. `lisp-interaction-mode-map' A keymap used by Lisp mode. `lisp-mode-map' A keymap used by Lisp mode. A keymap for minibuffer input with completion. `minibuffer-local-isearch-map' A keymap for editing isearch strings in the minibuffer. `minibuffer-local-map' Default keymap to use when reading from the minibuffer. `minibuffer-local-must-match-map' A keymap for minibuffer input with completion, for exact match. `mode-specific-map' The keymap for characters following `C-c'. Note, this is in the global map. This map is not actually mode specific: its name was chosen to be informative for the user in `C-h b' (`display-bindings'), where it describes the main use of the `C-c' prefix key. `modeline-map' The keymap consulted for mouse-clicks on the modeline of a window. `objc-mode-map' A keymap used in Objective C mode as a local map. `occur-mode-map' A local keymap used by Occur mode. `overriding-local-map' A keymap that overrides all other local keymaps. `query-replace-map' A local keymap used for responses in `query-replace' and related commands; also for `y-or-n-p' and `map-y-or-n-p'. The functions that use this map do not support prefix keys; they look up one event at a time. `read-expression-map' The minibuffer keymap used for reading Lisp expressions. `read-shell-command-map' The minibuffer keymap used by shell-command and related commands. `shared-lisp-mode-map' A keymap for commands shared by all sorts of Lisp modes. `text-mode-map' A keymap used by Text mode. `toolbar-map' The keymap consulted for mouse-clicks over a toolbar. `view-mode-map' A keymap used by View mode. File: lispref.info, Node: Standard Hooks, Next: Index, Prev: Standard Keymaps, Up: Top Standard Hooks ************** The following is a list of hook variables that let you provide functions to be called from within Emacs on suitable occasions. Most of these variables have names ending with `-hook'. They are "normal hooks", run by means of `run-hooks'. The value of such a hook is a list of functions. The recommended way to put a new function on such a hook is to call `add-hook'. *Note Hooks::, for more information about using hooks. The variables whose names end in `-function' have single functions as their values. Usually there is a specific reason why the variable is not a normal hook, such as the need to pass arguments to the function. (In older Emacs versions, some of these variables had names ending in `-hook' even though they were not normal hooks.) The variables whose names end in `-hooks' or `-functions' have lists of functions as their values, but these functions are called in a special way (they are passed arguments, or else their values are used). `activate-menubar-hook' `ad-definition-hooks' `add-log-current-defun-function' `after-change-function' `after-change-functions' `after-delete-annotation-hook' `after-init-hook' `after-insert-file-functions' `after-save-hook' `after-set-visited-file-name-hooks' `after-write-file-hooks' `auto-fill-function' `auto-save-hook' `before-change-function' `before-change-functions' `before-delete-annotation-hook' `before-init-hook' `before-make-frame-hook' `blink-paren-function' `buffers-menu-switch-to-buffer-function' `c++-mode-hook' `c-mode-hook' `calendar-load-hook' `command-history-hook' `comment-indent-function' `compilation-buffer-name-function' `compilation-finish-function' `compilation-mode-hook' `create-frame-hook' `delete-frame-hook' `deselect-frame-hook' `diary-display-hook' `diary-hook' `dired-after-readin-hook' `dired-before-readin-hook' `dired-load-hook' `dired-mode-hook' `disabled-command-hook' `display-buffer-function' `edit-picture-hook' `electric-buffer-menu-mode-hook' `electric-command-history-hook' `electric-help-mode-hook' `emacs-lisp-mode-hook' `find-file-hooks' `find-file-not-found-hooks' `first-change-hook' `font-lock-mode-hook' `indent-line-function' `indent-mim-hook' `indent-region-function' `initial-calendar-window-hook' `isearch-mode-end-hook' `isearch-mode-hook' `kill-buffer-hook' `kill-buffer-query-functions' `kill-emacs-hook' `kill-emacs-query-functions' `kill-hooks' `LaTeX-mode-hook' `ledit-mode-hook' `LaTeX-mode-hook' `ledit-mode-hook' `lisp-indent-function' `lisp-interaction-mode-hook' `lisp-mode-hook' `list-diary-entries-hook' `m2-mode-hook' `mail-mode-hook' `mail-setup-hook' `make-annotation-hook' `map-frame-hook' `mark-diary-entries-hook' `medit-mode-hook' `menu-no-selection-hook' `mh-compose-letter-hook' `mh-folder-mode-hook' `mh-letter-mode-hook' `mim-mode-hook' `minibuffer-exit-hook' `minibuffer-setup-hook' `mode-motion-hook' `mouse-enter-frame-hook' `mouse-leave-frame-hook' `news-mode-hook' `news-reply-mode-hook' `news-setup-hook' `nongregorian-diary-listing-hook' `nongregorian-diary-marking-hook' `nroff-mode-hook' `outline-mode-hook' `plain-TeX-mode-hook' `post-command-hook' `post-gc-hook' `pre-abbrev-expand-hook' `pre-command-hook' `pre-display-buffer-function' `pre-gc-hook' `print-diary-entries-hook' `prolog-mode-hook' `protect-innocence-hook' `revert-buffer-function' `revert-buffer-insert-contents-function' `rmail-edit-mode-hook' `rmail-mode-hook' `rmail-summary-mode-hook' `scheme-indent-hook' `scheme-mode-hook' `scribe-mode-hook' `select-frame-hook' `send-mail-function' `shell-mode-hook' `shell-set-directory-error-hook' `suspend-hook' `suspend-resume-hook' `temp-buffer-show-function' `term-setup-hook' `terminal-mode-hook' `terminal-mode-break-hook' `TeX-mode-hook' `text-mode-hook' `today-visible-calendar-hook' `today-invisible-calendar-hook' `tooltalk-message-handler-hook' `tooltalk-pattern-handler-hook' `tooltalk-unprocessed-message-hook' `unmap-frame-hook' `vc-checkin-hook' `vi-mode-hook' `view-hook' `window-setup-hook' `write-contents-hooks' `write-file-hooks' `write-region-annotate-functions' `x-lost-selection-hooks' `x-sent-selection-hooks' `zmacs-activate-region-hook' `zmacs-deactivate-region-hook' `zmacs-update-region-hook'